<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home In Manchester</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description_mc" content="">
<meta name="author" content="">

<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="assets/css/docs.css" rel="stylesheet">
<link href="assets/js/google-code-prettify/prettify.css"
	rel="stylesheet">

<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
      <script src="assets/js/html5shiv.js"></script>
    <![endif]-->

<style>
body {
	font-family: 微软雅黑;
	font-size: 14px;
}

.nav-list {
	margin-top: 0px;
}

h4 {
	margin-top: 25px;
}
</style>
</head>

<body data-spy="scroll" data-target=".bs-docs-sidebar">

	<!-- Navbar
    ================================================== -->
	<div class="navbar navbar-inverse navbar-fixed-top">
		<div class="navbar-inner">
			<div class="container">
				<button type="button" class="btn btn-navbar" data-toggle="collapse"
					data-target=".nav-collapse">
					<span class="icon-bar"></span> <span class="icon-bar"></span> <span
						class="icon-bar"></span>
				</button>
				<div class="nav-collapse collapse">
					<ul class="nav">
						<li class=""><a href="index.html">首页</a></li>
						<li class=""><a href="live.html">生活信息</a></li>
						<li class=""><a href="func.html">实用功能</a></li>
						<li class=""><a href="forum.html">娱乐交友</a></li>
						<li class=""><a href="study.html">学术讨论</a></li>
						<li class="active"><a href="member.html">会员管理</a></li>
						<li class=""><a href="bookFood.html">订餐系统</a></li>
						<li class=""><a href="ticket.html">票务系统</a></li>
						<li class=""><a href="coupon.html">优惠券</a></li>
						<li class=""><a href="readme.html">补充说明</a></li>
						<li class=""><a href="extend.html">扩展功能</a></li>
						<li class=""><a href="advert.html">广告</a></li>
						<li class=""><a href="report.html">公告系统</a></li>
						<li class=""><a href="radio.html">电台系统</a></li>
					</ul>
				</div>
			</div>
		</div>
	</div>

	<!-- Subhead
================================================== -->
	<header class="jumbotron subhead" id="overview">
		<div class="container">
			<h1>客户端接口调用指南</h1>
			<p class="lead">web客户端、移动客户端获取和设置服务器数据的统一接口访问规范。符合restful的api设计范式，提供跨平台的基于http协议的一致web接口。</p>
		</div>
	</header>


	<div class="container">

		<!-- Docs nav
    ================================================== -->
		<div class="row">
			<div class="span3 bs-docs-sidebar">
				<h3>会员相关API</h3>
				<ul class="nav nav-list bs-docs-sidenav">
					<li><a href="#register"><i class="icon-chevron-right"></i>
							会员注册</a></li>
					<li><a href="#login"><i class="icon-chevron-right"></i>
							会员登录</a></li>
					<li><a href="#logout"><i class="icon-chevron-right"></i>
							会员退出系统</a></li>
					<li><a href="#changePass"><i class="icon-chevron-right"></i>
							修改密码</a></li>
					<li><a href="#validateCode"><i class="icon-chevron-right"></i>
							获取图片验证码</a></li>
					<li><a href="#getInfo"><i class="icon-chevron-right"></i>
							获取会员详细信息</a></li>
					<li><a href="#updateInfo"><i class="icon-chevron-right"></i>
							完善会员详细信息</a></li>
					<li><a href="#uploadHeader"><i class="icon-chevron-right"></i>
							上传用户头像</a></li>

					<li><a href="#addFriends"><i class="icon-chevron-right"></i>
							批量加好友</a></li>
					<li><a href="#addFriend"><i class="icon-chevron-right"></i>
							单个加好友</a></li>
					<li><a href="#getApplyFriends"><i
							class="icon-chevron-right"></i> 获取好友申请列表</a></li>
					<li><a href="#getAllowedFriends"><i
							class="icon-chevron-right"></i> 获取会员好友列表</a></li>
					<li><a href="#applyFriend"><i class="icon-chevron-right"></i>
							好友申请审核</a></li>
					<li><a href="#refuseFriend"><i class="icon-chevron-right"></i>
							好友申请拒绝</a></li>

					<li><a href="#getByHomeTown"><i class="icon-chevron-right"></i>
							获取老乡推荐列表</a></li>
					<li><a href="#getBySchool"><i class="icon-chevron-right"></i>
							获取同校推荐列表</a></li>
							
					<li><a href="#sorts"><i class="icon-chevron-right"></i>
							固定分类</a></li>
					
				</ul>

			</div>
			<div class="span9">



				<!-- Typography
        ================================================== -->
				<section id="register">
					<div class="page-header">
						<h1>会员注册API</h1>
					</div>

					<h3>1 功能说明</h3>
					<p>系统预置了三种注册功能。邮箱注册由于不适合手机客户端，故系统虽然设计了，但不建议移动客户端使用；手机注册尚未开通，所以目前主要以普通注册方式为主。</p>
					<p>
						1、<strong>普通注册。</strong>
					</p>
					<p>只需要提供用户名、密码、验证码即可注册成功。</p>

					<p>
						2、<strong>邮箱注册。</strong>
					</p>
					<p>除了提供用户名、密码之外，还需要提供邮箱，系统会自动发送激活码消息到邮箱，用户需要打开邮箱进行激活链接。这种邮箱注册模式在web浏览器上使用效果最佳。</p>

					<p>
						3、<strong>手机注册。</strong>
					</p>
					<p>除了提供用户名、密码之外，需要提供手机号，系统会立即向该手机发送验证码，然后输入正确的验证码即可通过注册。这种方式最适合移动客户端，但因为目前我们缺少合作的短信平台，并且需要支付额外的短信费用，需要后期确认后增加。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/register</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/register</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数:</p>
					<p>这里的参数为一个json字符串，内容符合如下格式：</p>
					<pre>
{
    "type": 0, 
    "username": "ffff", 
    "password": "sss", 
    "validateCode": "7jk5"
}					
					</pre>
					<p>对以上json字符串中的key参数进行说明：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>type</td>
								<td>必填</td>
								<td>Integer</td>
								<td>注册类型。0为普通注册，1为邮箱注册，2为手机注册。</td>
							</tr>
							<tr>
								<td>username</td>
								<td>必填</td>
								<td>String</td>
								<td>用户名。用户名需要客户端进行验证，不能为空，长度限制等等。服务器端只验证不能为空，不允许重复。</td>
							</tr>
							<tr>
								<td>password</td>
								<td>必填</td>
								<td>String</td>
								<td>密码。密码需要客户端进行验证，不能为空，长度限制等等。服务器端只验证不能为空。</td>
							</tr>
							<tr>
								<td>validateCode</td>
								<td>必填</td>
								<td>String</td>
								<td>验证码。服务器端提供获取<a href="member.html#validateCode">图片验证码</a>的接口，客户端必须输入正确的验证码才允许注册。
								</td>
							</tr>
							<tr style="background: #eeeeee; color: green;">
								<td>email</td>
								<td>选填</td>
								<td>String</td>
								<td>如果type=1的话，此处email参数则为必填，而且email要合法，后台有对email的合法性验证，最好在客户端验证，节约流量，提高速度。</td>
							</tr>
							<tr style="background: #eeefff; color: green;">
								<td>phone</td>
								<td>选填</td>
								<td>String</td>
								<td>如果type=2的话，此处phone参数为必填，而且phone要合法，后台有对phone的合法性验证（为国内的标准的11位电话号码）。</td>
							</tr>
							<tr style="background: #eeefff; color: green;">
								<td>phoneCode</td>
								<td></td>
								<td>String</td>
								<td>手机验证码。如果type=2的话，采用手机注册时，需提供此参数，且为必填。</td>
							</tr>
						</tbody>
					</table>
					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/register</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回true。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2001</td>
								<td>验证码不正确！</td>
								<td>必填项：validateCode缺失或错误</td>
							</tr>
							<tr>
								<td>2004</td>
								<td>密码不能为空！</td>
								<td>必填项：password缺失</td>
							</tr>
							<tr>
								<td>2005</td>
								<td>昵称不能为空！</td>
								<td>必填项：username缺失</td>
							</tr>
							<tr>
								<td>2010</td>
								<td>用户名已经被占用！</td>
								<td>username账号已经被使用的提示</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>

					<pre>
true
</pre>
					<h4>2.9 错误返回示例</h4>
					<pre>
{
    "msg": "用户名已经被占用！", 
    "object": null, 
    "code": "2010"
}
					</pre>


				</section>


				<!-- Code
        ================================================== -->
				<section id="login">
					<div class="page-header">
						<h1>会员登录API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>会员登录功能。本系统在有些场合下是需要会员登录的，如论坛发帖、同城交友等。</p>
					<p>
						<strong>假设</strong>
					</p>
					<p>系统假设所有的客户端都具备session会话功能，当客户端登录成功后，会自动保存会话状态，直到会话失效。在会话有效期内，客户端所提交的某些信息是和当前登录用户有关的，比如论坛发帖，系统会自动记录当前发帖人、发帖人的ID。</p>
					<p>
						<strong>如果</strong>
					</p>
					<p>如果客户端不具备session会话功能，就需要模拟会话操作。在登录成功后返回的user对象中，有一个字段为：jsessionId，在以后的所有需要会话的请求中，请务必在header中设置：</p>
					<p>
						<code>post.addRequestHeader("Cookie" ,
							"JSESSIONID=C97A61F85CD46A87D3E5C4C068689504");</code>
					</p>
					<p>注：这里是以java为例，其他语言请自行设置。上面的C97A61F85CD46A87D3E5C4C068689504即为user对象返回的jsessionId。</p>
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/login</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/login</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>username</td>
								<td>必填</td>
								<td>String</td>
								<td>用户名。（或者叫昵称）</td>
							</tr>
							<tr>
								<td>password</td>
								<td>必填</td>
								<td>String</td>
								<td>密码。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/login</code>

					<h4>2.6 返回参数说明</h4>
					<p>登录成功，会返回用户基本信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>username</td>
								<td>String</td>
								<td>用户名。</td>
							</tr>
							<tr>
								<td>email</td>
								<td>String</td>
								<td>邮箱。</td>
							</tr>
							<tr>
								<td>remoteIp</td>
								<td>String</td>
								<td>用户ip。</td>
							</tr>
							<tr>
								<td>actived</td>
								<td>Integer</td>
								<td>是否激活。1为激活用户，0为未激活。</td>
							</tr>
							<tr>
								<td>registerTime</td>
								<td>String</td>
								<td>注册时间</td>
							</tr>
							<tr>
								<td>validateCode</td>
								<td>String</td>
								<td>注册验证码，注册时有用，返回结果无用。</td>
							</tr>
							<tr>
								<td>phone</td>
								<td>String</td>
								<td>手机号。</td>
							</tr>
							<tr>
								<td>userId</td>
								<td>Integer</td>
								<td>用户唯一标识。</td>
							</tr>
							<tr>
								<td>type</td>
								<td>Integer</td>
								<td>注册类型。</td>
							</tr>
							<tr>
								<td>level</td>
								<td>Integer</td>
								<td>用户级别。</td>
							</tr>
							<tr>
								<td>password</td>
								<td>String</td>
								<td>用户密码。经过md5加密。</td>
							</tr>
							<tr>
								<td>jsessionId</td>
								<td>String</td>
								<td>当前用户所在会话ID。如果客户端不具备自动保存会话功能，则需要再以后的请求发起中，设置cookie为当前的会话ID。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2100</td>
								<td>用户名为空！</td>
								<td>必填项：username缺失</td>
							</tr>
							<tr>
								<td>2101</td>
								<td>密码不能为空！</td>
								<td>必填项：password缺失</td>
							</tr>
							<tr>
								<td>2102</td>
								<td>用户名不正确！</td>
								<td>必填项：username错误</td>
							</tr>
							<tr>
								<td>2103</td>
								<td>密码不正确！</td>
								<td>必填项：password错误</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/login</code>
					<pre>
{
    "username": "test", 
    "email": "82315040@qq.com", 
    "remoteIp": null, 
    "actived": 1, 
    "registerTime": null, 
    "validateCode": null, 
    "phone": null, 
    "userId": 19, 
    "type": 0, 
    "level": 0, 
    "password": "C4CA4238A0B923820DCC509A6F75849B",
    "jsessionId":"B72415F178D3B3934F2C65640FB8E826"
}
						</pre>



					<h4>2.9 错误返回示例</h4>
					<pre>
{
    "msg": "密码不正确！", 
    "object": null, 
    "code": "2103"
}
					</pre>


				</section>

				<section id="logout">
					<div class="page-header">
						<h1>会员退出系统API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>退出系统。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/logout</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/logout</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST,GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无。</p>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/logout</code>

					<h4>2.6 返回参数说明</h4>
					{"value":"true"}
					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/logout</code>
					<pre>
{
    "value": "true"
}
						</pre>

				</section>
				
				<section id="changePass">
					<div class="page-header">
						<h1>修改密码API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>会员登录后，可以修改自己的密码。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/user/password</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/user/password</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST,GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>oldPassword</td>
								<td>必填</td>
								<td>String</td>
								<td>原有密码</td>
							</tr>
							<tr>
								<td>newPassword</td>
								<td>必填</td>
								<td>String</td>
								<td>新密码。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/user/password</code>

					<h4>2.6 返回参数说明</h4>
					

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2103</td>
								<td>密码不正确！</td>
								<td>必填项：password错误</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/user/password</code>
					<pre>
{
    "value": "true"
}
						</pre>



					<h4>2.9 错误返回示例</h4>
					<pre>
{
    "msg": "密码不正确！", 
    "object": null, 
    "code": "2103"
}
					</pre>


				</section>

				<section id="validateCode">
					<div class="page-header">
						<h1>获取图片验证码API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>用户注册时，需要服务器端提供图片验证码，用于防止暴力注册。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/validatecode</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>
					<h4>2.2 返回格式</h4>
					<p>二进制流（图片）</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无</p>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/validatecode</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>返回为图片</p>


					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：暂无。</p>

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/validatecode</code>
					<p class="row" style="margin-left: 20px; margin-top: 10px;">
						<img src='../img/validatecode.jpg'
							style="border: 1px solid #dddddd;">
					</p>


				</section>

				<!-- 获取会员详细信息
=======================================================
 -->
				<section id="getInfo">
					<div class="page-header">
						<h1>获取会员详细信息API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>获取登录用户的个人详细资料，包括姓名、男女、工作单位等等。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/info/{userId}</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无</p>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/info/36</code>
					</p>
					<p>这里表示请求userId=36的用户详细资料。</p>

					<h4 id="user-info">2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>header</td>
								<td>String</td>
								<td>头像。返回为图片的url地址链接。</td>
							</tr>
							<tr>
								<td>userId</td>
								<td>Long</td>
								<td>用户ID</td>
							</tr>
							<tr>
								<td>school</td>
								<td>Integer</td>
								<td>学校代码。0表示没有填写学校，1表示曼彻斯特大学，其他大学代码可以参考表格<a
									href="member.html#schoolCode">《学校名称代码表》</a></td>
							</tr>
							<tr>
								<td>homeTown</td>
								<td>String</td>
								<td>家乡城市代码。返回null表示没有设置家乡。其他字符串代码可以参考excel表格<a
									href="member.html#cities.xls">《中国城市代码表.xls》</a></td>
							</tr>
							<tr>
								<td>gender</td>
								<td>Integer</td>
								<td>性别。1表示男，0表示女。</td>
							</tr>
							<tr>
								<td>workPlace</td>
								<td>String</td>
								<td>工作单位或者学校院系。</td>
							</tr>
							<tr>
								<td>birthday</td>
								<td>String</td>
								<td>生日。</td>
							</tr>
							<tr>
								<td>toSchoolYear</td>
								<td>String</td>
								<td>入学年份。</td>
							</tr>
							<tr>
								<td>name</td>
								<td>String</td>
								<td>姓名。</td>
							</tr>
							<tr>
								<td>description_mc</td>
								<td>String</td>
								<td>个人简介。</td>
							</tr>
							<tr>
								<td>status</td>
								<td>Integer</td>
								<td>0标识工作了，1标识上大学，2标识上中学，3标识其他</td>
							</tr>
							<tr>
								<td>cityId</td>
								<td>Integer</td>
								<td>所在城市ID</td>
							</tr>
							<tr>
								<td>cityName</td>
								<td>String</td>
								<td>所在城市名称</td>
							</tr>
							<tr>
								<td>provinceId</td>
								<td>Integer</td>
								<td>所在省份ID</td>
							</tr>
							<tr>
								<td>provinceName</td>
								<td>String</td>
								<td>所在省份名称</td>
							</tr>
						</tbody>
					</table>


					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：暂无。</p>

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/user/info/36</code>
					<pre>
{
    "header": null, 
    "userId": 36, 
    "school": 0, 
    "homeTown": null, 
    "gender": 1, 
    "workPlace": null, 
    "birthday": "1990-12-22", 
    "toSchoolYear": null, 
    "name": "sdsdssd", 
    "description_mc": "sdsfsd，三打三防", 
    "status": 0
}						
						</pre>


				</section>



				<section id="updateInfo">
					<div class="page-header">
						<h1>完善会员详细信息API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>一般用户注册完成之后，需要引导客户填写详细信息，比如：填写基本信息及人生履历等等。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/info</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<p>这里需要提交的数据为一个json字符串，对象原型为UserInfo,格式信息如下：</p>
					<pre>
{
    "name": "小二黑", 
    "gender": 1, 
    "workPlace": "数学系",
    "birthday": "1990-05-11",
    "description_mc": "",
    "status": 1,
    "school": 1,
    "toSchoolYear": "2012",
    "homeTown": "200100"
}				
					</pre>
					<p>上面的json信息并不一定全，可能是一部分，根据客户端实际情况发送，比如要提交的json串也可能是下面：</p>
					<pre>
{
    "name": "小二黑", 
    "gender": 1, 
    "workPlace": "数学系",
    "birthday": "1990-05-11"
}    					
					</pre>
					<p>下面将针对所有的参数（json串中的key）进行详细介绍：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>name</td>
								<td>选填</td>
								<td>String</td>
								<td>姓名。</td>
							</tr>
							<tr>
								<td>gender</td>
								<td>选填</td>
								<td>Integer</td>
								<td>1标识男，0标识女。</td>
							</tr>
							<tr>
								<td>workPlace</td>
								<td>选填</td>
								<td>String</td>
								<td>工作单位或者是学校院系。</td>
							</tr>
							<tr>
								<td>birthday</td>
								<td>选填</td>
								<td>String</td>
								<td>生日。格式为：yyyy-MM-dd</td>
							</tr>
							<tr>
								<td>description_mc</td>
								<td>选填</td>
								<td>String</td>
								<td>个人简介。字符最多500个字符。</td>
							</tr>
							<tr>
								<td>status</td>
								<td>选填</td>
								<td>Integer</td>
								<td>0标识工作了，1标识上大学，2标识上中学，3标识其他</td>
							</tr>
							<tr>
								<td>school</td>
								<td>选填</td>
								<td>String</td>
								<td>如果status=1或者2则需要提供该字段。这个自由发挥，实际并不受限制。</td>
							</tr>
							<tr>
								<td>toSchoolYear</td>
								<td>选填</td>
								<td>String</td>
								<td>上学时间。格式为yyyy。</td>
							</tr>
							<tr class="error">
								<td>homeTown</td>
								<td>选填</td>
								<td>String</td>
								<td>家乡。这里填写的是家乡所在城市的城市代码，具体城市代码可以参考<a
									href="../img/cities.xls">《中国城市代码表.xls》</a>
									<font color=red>该数据目前不再使用！</font>
									</td>
							</tr>
							<tr class="success">
								<td>provinceId</td>
								<td>必填</td>
								<td>Integer</td>
								<td>省份ID，具体获取省份列表参考<a href="#provinces">《省份》</a></td>
							</tr>
							<tr class="success">
								<td>cityId</td>
								<td>必填</td>
								<td>Integer</td>
								<td>城市ID，具体获取城市列表参考<a href="#cities">《城市》</a></td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/info</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回true。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>未登录用户无法完善个人资料。</td>
							</tr>

						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>
						请求json字符串为：
						<code>{"name":"sdsdssd","gender":1,"birthday":"1990-12-22","description_mc":"sdsfsd，三打三防"}
						</code>
					</p>
					<p>
						请求http地址为：
						<code>http://115.29.250.136:8080/homeInManchester/api/user/info</code>
					</p>
					<pre>
true
					</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/info</code>
					</p>
					<pre>
{"msg":"会员未登录！","object":null,"code":"2000"}				
				</pre>

				</section>

				<section id="uploadHeader">
					<div class="page-header">
						<h1>上传用户头像API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>完善用户信息时，需要上传或修改用户头像，目前要求上传图片为jpeg格式。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/header</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST(客户端模拟multipart/formdata参数提交)</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。暂无。</p>
					

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/header</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回上传后的图片名称。</p>
					<p><code>6c28ba9d-0599-4fdc-bad8-abab461a93c7.jpg</code></p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
							
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					
					<code>http://115.29.250.136:8080/homeInManchester/api/user/header</code>
					<pre>
6c28ba9d-0599-4fdc-bad8-abab461a93c7.jpg
						</pre>
					<p>实际存储位置为：</p>
					<p><code>http://115.29.250.136:8080/homeInManchester/resources/fileupload/header/6c28ba9d-0599-4fdc-bad8-abab461a93c7.jpg</code></p>


					
				</section>






				<section id="addFriends">
					<div class="page-header">
						<h1>批量加好友API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>加好友功能主要在同城推荐使用。一般是用户注册成功后，引导用户完善用户详细资料，同时根据用户提供的某些资料查找相关用户进行推荐，对于感兴趣的朋友，用户可以进行加好友操作。</p>
					<p>
						这里是批量增加好友功能，另外还有<a href="member.html#addFriend">单个增加好友</a>。
					</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/friends</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>friends</td>
								<td>选填</td>
								<td>String</td>
								<td>要增加的好友ID。单个用户，直接为用户ID即可，如果是多个，用户ID之间请用半角","连接。如：12,23,44</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回true。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>请求参数：</p>
					<p>
						<code>friends="34,35,36"</code>
					</p>
					<p>请求地址：</p>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends</code>
					</p>
					<pre>
true
						</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends</code>
					</p>
					<pre>
{"msg":"会员未登录","object":null,"code":"2000"}				
				</pre>

				</section>


				<section id="addFriend">
					<div class="page-header">
						<h1>单个加好友API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>功能与批量加好友API相同，这里是单个增加好友，可以发送申请信息。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/friend</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>

					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>friendId</td>
								<td>选填</td>
								<td>Long</td>
								<td>对方用户ID。（userId）</td>
							</tr>
							<tr>
								<td>message</td>
								<td>选填</td>
								<td>String</td>
								<td>申请加好友的信息，最大长度100个字符。如："xxx申请加你为好友"，或者为："Hi，我是xxx，交个朋友吧"
									之类的。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friend</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回true。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>请求参数：</p>
					<p>
						<code>friendId=32,message="小黑猫申请加你为好友"</code>
					</p>
					<p>请求地址：</p>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friend</code>
					</p>
					<pre>
true
						</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends</code>
					</p>
					<pre>
{"msg":"会员未登录","object":null,"code":"2000"}				
				</pre>
				</section>


				<section id="getApplyFriends">
					<div class="page-header">
						<h1>获取好友申请列表API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>会员登录后，可以随时查看系统消息，有没有人申请加我为好友，该功能即为查看要加我为好友的申请列表。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/friends/apply</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。暂无。</p>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends/apply</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>userId</td>
								<td>Long</td>
								<td>当前登录用户ID。</td>
							</tr>
							<tr>
								<td>fiendId</td>
								<td>Long</td>
								<td>申请人ID</td>
							</tr>
							<tr>
								<td>friendname</td>
								<td>String</td>
								<td>申请加好友的昵称（用户名）</td>
							</tr>
							<tr>
								<td>message</td>
								<td>String</td>
								<td>申请信息。</td>
							</tr>
							<tr>
								<td>status</td>
								<td>Integer</td>
								<td>加好友状态。1表示已通过认证，0表示申请状态。这里返回的是申请列表，故status均为0。</td>
							</tr>

						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>当前登录用户为hsmart，用户ID为21。（需要登录并保持session状态。）</p>
					<code>http://115.29.250.136:8080/homeInManchester/api/user/friends/apply</code>
					<pre>
[
    {
        "userId": 21, 
        "fiendId": 32, 
        "friendname": "what", 
        "message": "小黑猫申请加你为好友", 
        "status": 0
    }, 
    {
        "userId": 21, 
        "fiendId": 34, 
        "friendname": "aaa", 
        "message": null, 
        "status": 0
    }, 
    {
        "userId": 21, 
        "fiendId": 35, 
        "friendname": "xysz", 
        "message": null, 
        "status": 0
    }, 
    {
        "userId": 21, 
        "fiendId": 36, 
        "friendname": "boy001", 
        "message": null, 
        "status": 0
    }
]
						</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends/apply</code>
					</p>
					<pre>
{"msg":"会员未登录，不允许发表回复！","object":null,"code":"2000"}				
					</pre>

				</section>

				<section id="getAllowedFriends">
					<div class="page-header">
						<h1>获取会员好友列表API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>查看审核通过的好友列表。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/friends/allowed</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。暂无。</p>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends/allowed</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>numPerPage</td>
								<td>Integer</td>
								<td>每页显示条数。</td>
							</tr>
							<tr>
								<td>pageNum</td>
								<td>Integer</td>
								<td>当前第几页。</td>
							</tr>
							<tr>
								<td>totalCount</td>
								<td>Integer</td>
								<td>总的主题数。</td>
							</tr>
							<tr>
								<td>totalPage</td>
								<td>Integer</td>
								<td>总页数。</td>
							</tr>
							<tr>
								<td>result</td>
								<td>Object[]</td>
								<td>好友信息列表集合，具体返回参数说明参考下面<a href="#result_friend">《result的具体返回参数说明》</a></td>
							</tr>
						</tbody>
					</table>
					<p id="result_friend"><strong>result的具体返回参数说明</strong></p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>userId</td>
								<td>Long</td>
								<td>查询的会员ID</td>
							</tr>
							<tr>
								<td>friendId</td>
								<td>Long</td>
								<td>好友的会员ID</td>
							</tr>
							<tr>
								<td>status</td>
								<td>int</td>
								<td>好友状态。1为正常的好友关系。</td>
							</tr>
							<tr>
								<td>message</td>
								<td>String</td>
								<td>申请好友时发送的消息。</td>
							</tr>
							<tr>
								<td>friendname</td>
								<td>String</td>
								<td>好友的会员账号。</td>
							</tr>
							<tr>
								<td>username</td>
								<td>String</td>
								<td>查询的会员账号。</td>
							</tr>
							<tr>
								<td>friendHeader</td>
								<td>String</td>
								<td>好友的头像</td>
							</tr>
							<tr>
								<td>userHeader</td>
								<td>String</td>
								<td>查询的的会员头像</td>
							</tr>	
						</tbody>
					</table>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>当前登录用户为mazingyu，用户ID为92。（需要登录并保持session状态。）</p>
					<code>http://115.29.250.136:8080/homeInManchester/api/user/friends/allowed</code>
					<pre>
[
    {
        friendHeader: null
		friendId: 89
		friendname: "why"
		message: "好友申请已发送"
		status: 1
		userHeader: "c2403ec5-d65d-4f13-8bf8-65417c9e1123.png"
		userId: 92
		username: "mazingyu"
    }, 
    {
        friendHeader: "910a1018-4bda-4a1a-95ab-24e3cf760964.png"
		friendId: 86
		friendname: "12345"
		message: "Hello 12345"
		status: 1
		userHeader: "c2403ec5-d65d-4f13-8bf8-65417c9e1123.png"
		userId: 92
		username: "mazingyu"
    }
]
						</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friends/allowed</code>
					</p>
					<pre>
{"msg":"会员未登录！","object":null,"code":"2000"}				
					</pre>

				</section>

				<section id="applyFriend">
					<div class="page-header">
						<h1>好友申请审核API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>好友申请审核功能。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/friend/allow</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>friendId</td>
								<td>必填</td>
								<td>Long</td>
								<td>好友ID。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friend/allow</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回true。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>假设传参为：friendId=35。</p>
					<code>http://115.29.250.136:8080/homeInManchester/api/user/friend/allow</code>
					<pre>
true
					</pre>


					<h4>2.9 错误返回示例</h4>

					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/forum/post</code>
					</p>
					<pre>
{"msg":"会员未登录！","object":null,"code":"2000"}				
				</pre>
					
				</section>
				
				<section id="refuseFriend">
					<div class="page-header">
						<h1>好友申请拒绝API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>好友申请拒绝功能。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/user/friend/refuse</code>
					</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>friendId</td>
								<td>必填</td>
								<td>Long</td>
								<td>好友ID。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/user/friend/refuse</code>
					</p>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回true。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>用来判断会员是否登录。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					<p>假设传参为：friendId=35。</p>
					<code>http://115.29.250.136:8080/homeInManchester/api/user/friend/refuse</code>
					<pre>
true
					</pre>


					<h4>2.9 错误返回示例</h4>

					<pre>
{"msg":"会员未登录！","object":null,"code":"2000"}				
				</pre>
					
				</section>

				<section id="getByHomeTown">
					<div class="page-header">
						<h1>获取按老乡推荐用户API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>根据家乡所在城市，推荐用户列表，亦即为该用户推荐老乡。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/users/suggest/hometown/{homeTown}</code>
					</p>
					<p>{homeTown}为占位符，标识家乡城市代码。</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。暂无。</p>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/users/suggest/hometown/220500</code>
					</p>
					<p>220500 为城市代码，具体代码可以下载查看<a href="../img/cities.xls">城市代码表.xls</a></p>
					
					<h4>2.6 返回参数说明</h4>
					<p>返回参数为符合要求的用户列表，具体参数说明可以参考：<a href="member.html#user-info">用户基本参数</a>。</p>
					<p >
						<font color=red>新增返回参数：friendStatus.返回值有-1、0、1、2，具体含义可参考 <a href="member.html#friend-status">好友状态</a></font>
					</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：暂无。</p>

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/users/suggest/hometown/220500</code>
					<pre>
[
    {
        "username": "xysz", 
        "header": null, 
        "userId": 35, 
        "school": 1, 
        "homeTown": "220500", 
        "gender": 0, 
        "workPlace": "sdsdsd", 
        "birthday": null, 
        "friendStatus": 1, 
        "toSchoolYear": null, 
        "name": "sdss", 
        "description_mc": null, 
        "status": 0
    }, 
    {
        "username": "boy001", 
        "header": null, 
        "userId": 36, 
        "school": 1, 
        "homeTown": "220500", 
        "gender": 1, 
        "workPlace": "dddd", 
        "birthday": "1990-12-22", 
        "friendStatus": 0, 
        "toSchoolYear": null, 
        "name": "sdsdssd", 
        "description_mc": "sdsfsd，三打三防", 
        "status": 0
    }
]
						</pre>


					
				</section>

				<section id="getBySchool">
					<div class="page-header">
						<h1>获取按学校推荐用户API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>根据大学名称，推荐用户列表，亦即为该用户推荐同校同学。</p>

					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：</p>
					<p>
						<code>http://[域名]/api/users/suggest/school/{school}</code>
					</p>
					<p>{school}为占位符，标识学校代码。</p>

					<p>测试环境：将[域名]替换为：115.29.250.136:8080/homeInManchester</p>

					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。暂无。</p>

					<h4>2.5 请求示例</h4>
					<p>
						<code>http://115.29.250.136:8080/homeInManchester/api/users/suggest/school/1</code>
					</p>
					<p>1 为学校编号，具体学校编号可以参考<a href="member.html#school-number">学校编号</a></p>
					
					<h4>2.6 返回参数说明</h4>
					<p>返回参数为符合要求的用户列表，具体参数说明可以参考：<a href="member.html#user-info">用户基本参数</a>。</p>
					<p >
						<font color=red>新增返回参数：friendStatus.返回值有-1、0、1、2，具体含义可参考 <a href="member.html#friend-status">好友状态</a></font>
					</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：暂无。</p>

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/users/suggest/school/1</code>
					<pre>
[
    {
        "username": "xysz", 
        "header": null, 
        "userId": 35, 
        "school": 1, 
        "homeTown": "220500", 
        "gender": 0, 
        "workPlace": "sdsdsd", 
        "birthday": null, 
        "toSchoolYear": null, 
        "name": "sdss", 
        "description_mc": null, 
        "status": 0
    }, 
    {
        "username": "boy001", 
        "header": null, 
        "userId": 36, 
        "school": 1, 
        "homeTown": "220500", 
        "gender": 1, 
        "workPlace": "dddd", 
        "birthday": "1990-12-22", 
        "toSchoolYear": null, 
        "name": "sdsdssd", 
        "description_mc": "sdsfsd，三打三防", 
        "status": 0
    }
]
						</pre>


					
				</section>
				
				<section id="sorts">
				
				<div class="page-header">
						<h1>固定分类</h1>
					</div>
					<h3 id="school-number">英国著名高校列表（未完，待补充）</h3>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="100">编码</th>
								<th width="">中文名称</th>
								<th>英文名称</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>1</td>
								<td>曼彻斯特大学</td>
								<td>The University of Manchester</td>
							</tr>
							<tr>
								<td>2</td>
								<td>曼彻斯特城市大学</td>
								<td>Manchester Metropolitan University</td>
							</tr>
							<tr>
								<td>3</td>
								<td>&nbsp;</td>
								<td>The Royal Northern College of Music</td>
							</tr>
							<tr>
								<td>4</td>
								<td>&nbsp;</td>
								<td>University of Salford</td>
							</tr>
							<tr>
								<td>5</td>
								<td>&nbsp;</td>
								<td>INTO Manchester</td>
							</tr>
							
						</tbody>
					</table>
					
					<h4 id="friend-status">好友状态</h4>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th>名称</th>
								<th width="100">类型</th>
								<th>代码标识</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>无关状态</td>
								<td>Integer</td>
								<td>-1</td>
							</tr>
							<tr>
								<td>申请状态</td>
								<td>Integer</td>
								<td>0</td>
							</tr>
							<tr>
								<td>通过审核</td>
								<td>Integer</td>
								<td>1</td>
							</tr>
							<tr>
								<td>申请被拒绝</td>
								<td>Integer</td>
								<td>2</td>
							</tr>
						</tbody>
					</table>
					
				</section>


			</div>
		</div>

	</div>



	<!-- Footer
    ================================================== -->
	<footer class="footer">
		<div class="container">
			<p>
				Designed and built with all the love in the world by <a
					href="http://www.hcrazy.com" target="_blank">@hsmart</a>
			</p>
			<ul class="footer-links">
				<li><a href="http://www.hcrazy.com">Blog</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Issues</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Changelog</a></li>
			</ul>
		</div>
	</footer>



	<!-- Le javascript
    ================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="assets/js/jquery.js"></script>
	<script src="assets/js/bootstrap-transition.js"></script>
	<script src="assets/js/bootstrap-alert.js"></script>
	<script src="assets/js/bootstrap-modal.js"></script>
	<script src="assets/js/bootstrap-dropdown.js"></script>
	<script src="assets/js/bootstrap-scrollspy.js"></script>
	<script src="assets/js/bootstrap-tab.js"></script>
	<script src="assets/js/bootstrap-tooltip.js"></script>
	<script src="assets/js/bootstrap-popover.js"></script>
	<script src="assets/js/bootstrap-button.js"></script>
	<script src="assets/js/bootstrap-collapse.js"></script>
	<script src="assets/js/bootstrap-carousel.js"></script>
	<script src="assets/js/bootstrap-typeahead.js"></script>
	<script src="assets/js/bootstrap-affix.js"></script>

	<script src="assets/js/holder/holder.js"></script>
	<script src="assets/js/google-code-prettify/prettify.js"></script>

	<script src="assets/js/application.js"></script>



</body>
</html>
